Класс TextFormat

Доступность

Flash Player 6.

Описание

Класс TextFormat предоставляет информацию о форматировании символов.

Вы должны использовать конструктор new TextFormat() для создания объекта TextFormat до того, как воспользоваться его методами.

Вы можете установить параметры объекта TextFormat равными null, чтобы показать, что они не определены. Когда вы применяете TextFormat объект к текстовому полю, используя TextField.setTextFormat(), применяяются лишь те свойства, которые определены, как это показано на примере:

this.createTextField("my_txt", this.getNextHighestDepth(), 0, 0, 100, 22);
my_txt.autoSize = true;
my_txt.text = "Lorem ipsum dolor sit amet...";

var my_fmt:TextFormat = new TextFormat();
my_fmt.bold = true;
my_txt.setTextFormat(my_fmt);

Этот код сначала создает пустой объект TextFormat, все свойства которого имеются значение null, а затем устанавливает ему свойство bold.

Код my_txt.setTextFormat(my_fmt) изменяет свойство bold начального формата текстового поля, т.к. только свойство bold задано в my_fmt. Все остальные свойства форматирования текстового поля остаются неизменными.

При вызове TextField.getTextFormat(), возвращается объект TextFormat со всеми его определенными свойствами; возвращаются лишь свойства, значение которых не равно null.

Обзор методов класса TextFormat

Метод

Описание

TextFormat.getTextExtent()

Возвращает метрические характеристики строки.

Обзор свойств класса TextFormat

Свойство

Описание

TextFormat.align

Определяет выравнивание параграфа.

TextFormat.blockIndent

Определяет величину отступа в пикселах.

TextFormat.bold

Определяет жирное ли у шрифта начертание.

TextFormat.bullet

Определяет, помечен ли текст буллетом (то есть является ли он пунктом в ненумерованном списке).

TextFormat.color

Определяет цвет текста .

TextFormat.font

Определяет название шрифта.

TextFormat.indent

Определяет расстояние от левого отступа до первого символа в параграфе.

TextFormat.italic

Определяет, курсивное ли у шрифта начертание.

TextFormat.leading

Определяет вертикальное расстояние между строками (называемое интерлиньяжем).

TextFormat.leftMargin

Определяет величину левого отступа в параграфе .

TextFormat.rightMargin

Определяет величину правого отступа в параграфе.

TextFormat.size

Определяет размер шрифта .

TextFormat.tabStops

Определяет величины отступов в тексте.

TextFormat.target

Определяет окно браузера, в котором открывается гиперссылка .

TextFormat.underline

Определяет, подчеркнут ли текст .

TextFormat.url

Определяет URL, на который ссылается текст .

Конструктор класса TextFormat

Доступность

Flash Player 6.

Синтаксис

new TextFormat([font:String, [size:Number, [color:Number, [bold:Boolean, [italic:Boolean, [underline:Boolean, [url:String, [target:String, [align:String, [leftMargin:Number, [rightMargin:Number, [indent:Number, [leading:Number]]]]]]]]]]]]]) : TextFormat

Параметры

font Имя шрифта, передаваемого как строка .

size Число, определяющее размер шрифта .

color Цвет текстав данном текстовом формате . Число содержит три 8-битных RGB компонента; например, 0xFF0000 есть красный, а 0x00FF00 — зеленый цвет.

bold Булева величина, показывающая, имеет или нет шрифт в данном текстовом формате жирное начертание.

italic Булева величина, показывающая, имеет или нет шрифт в данном текстовом формате курсивное начертание.

underline Булева величина, показывающая, подчеркнут или нет шрифт в данном текстовом формате.

url URL, на который ссылается текст. Если url есть пустая строка, текст не является гиперссылкой.

target Окно браузера, в котором открывается гиперссылка . Если этот параметр равен пустой строке, то ссылка открывается в окне по умолчанию, то есть _self. Если параметр url равен пустой строке или null, изменение данного свойства не будет иметь эффекта.

align Выравнивание параграфа, представленное в виде строкового значения. Значение "left" означает, что параграф выравнен по левому краю . Значение "center" означает, что текст центрирован, а "right" — что текст выравнен по правому краю.

leftMargin Величина левого отступа для параграфа, в пикселах.

rightMargin Величина правого отступа для параграфа, в пикселах.

indent Число, показывающее расстояние от левого отступа до первого символа в параграфе.

leading Вертикальное расстояние между строками (интерлиньяж) .

Возвращает

Ссылку на объект TextFormat.

Описание

Функция-конструктор; создает объект TextFormat с заданными параметрами. Вы можете изменять свойства объекта TextFormat, чтобы изменять форматирование текстовых полей.

Любому параметру может быть присвоено значение null, чтобы показать, что он неопределен. Все параметры являются необязательными; любой опущенный параметр принимает значение null.

Пример

Код в нижеследующем примере создает объект TextFormat, форматирует с его помощью текст в текстовом поле stats_txt и создает новое текстовое поле для отображения текста с таким же форматом :

// Определяем объект TextFormat
var my_fmt:TextFormat = new TextFormat();
my_fmt.bold = true;
my_fmt.font = "Arial";
my_fmt.size = 12;
my_fmt.color = 0xFF0000;
// Создаем текстовое поле.
this.createTextField("stats_txt", 5000, 10, 0, 530, 22);
// Применяем объект TextFormat к текстовому полю.
stats_txt.setNewTextFormat(my_fmt);
stats_txt.selectable = false;
stats_txt.text = "Lorem ipsum dolor sit amet...";

Чтобы посмотреть другой пример, смотри animations.fla в папке HelpExamples. Обычно ее можно найти по следующему пути: